home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Best of www.BestZips.com (Collector's Edition)
/
Best of WWW.BESTZIPS.COM Collector's Edition (JCSM Shareware) (JCS Marketing).ISO
/
help_sys
/
hlpgn131.zip
/
hlpgenb.mac
< prev
next >
Wrap
Text File
|
1996-09-05
|
21KB
|
699 lines
.begin_file
.com(=================================)
.com( pound b macro topic )
.com(=================================)
.ent(cmdpb,\'23b Macro,The )
.b(SYNTAX:) \'23b(text).n
.n
.b(EXPLANATION:) This .p1(macro) represents a list item that starts
with a bullet and with the given .b(text) in boldface. It should
be followed immediately by text..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2eent(glossary,Glossary, Keyboard ).n
\'2es.n
\'23b(Autorepeat)If held down a key will begin to send
its code repeatedly.\'2en.n
\'23b(Mode key)Modifier keys, used in conjunction with normal
keys. Includes shift, control and alternate.\'2en.n
\'23b(Scan code)A byte value or values sent to the computer.\'2en.n
\'2eend.n.n
.]
.b(SEE ALSO:) .j(cmdun,\'2eun), .j(cmdpp,\'23\'23), .j(cmdpn,\'23n).n
.end
.com(=================================)
.com( bi macro topic )
.com(=================================)
.ent(cmdbi,\'2ebi Macro,The )
.b(SYNTAX:) \'2ebi(string).n
.n
.b(EXPLANATION:) This .p1(macro) presents the given .b(string) in
bold face italic type..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2eent(intro,Introduction,Program ).n
\'2ebi(Finagle) is a double-ledger accounting .n
program. There will \'2ebu(never) be a problem .n
with the I.R.S. if you use \'2ebi(Finagle). Of .n
course, you \'2eiu(may) end up in jail, but .n
that's a small price to pay.\'2en.n
\'2eend.n.n
.]
.b(SEE ALSO:) .j(cmdi,\'2ei) .j(cmdbu,\'2ebu) .j(cmdiu,\'2eiu).n
.end
.com(=================================)
.com( bu macro topic )
.com(=================================)
.ent(cmdbu,\'2ebu Macro,The )
.b(SYNTAX:) \'2ebu(string).n
.n
.b(EXPLANATION:) This .p1(macro) presents the given .b(string) in
bold face underlined type..n
.n
.b(EXAMPLE:) See the example for the \'2ebi command..n
.n
.b(SEE ALSO:) .j(cmdi,\'2ei) .j(cmdbi,\'2ebi) .j(cmdiu,\'2eiu).n
.end
.com(=================================)
.com( iu macro topic )
.com(=================================)
.ent(cmdiu,\'2eiu Macro,The )
.b(SYNTAX:) \'2eiu(string).n
.n
.b(EXPLANATION:) This .p1(macro) presents the given .b(string) in
italic underlined type..n
.n
.b(EXAMPLE:) See the example for the \'2ebi command..n
.n
.b(SEE ALSO:) .j(cmdi,\'2ei) .j(cmdbu,\'2ebu) .j(cmdbi,\'2ebi).n
.end
.com(=================================)
.com( pound n macro topic )
.com(=================================)
.ent(cmdpn,\'23n Macro,The )
.b(SYNTAX:) \'23n(1).n
.n
.b(EXPLANATION:) This .p1(macro) represents a numbered list item.
It should be followed immediately by text..n
.n
.b(EXAMPLE:) See the example for the \'2ein command..n
.n
.b(SEE ALSO:) .j(cmdun,\'2eun), .j(cmdpp,\'23\'23), .j(cmdpb,\'23b).n
.end
.com(=================================)
.com( b macro topic )
.com(=================================)
.ent(cmdb,\'2eb Macro,The )
.b(SYNTAX:) \'2eb(string).n
.n
.b(EXPLANATION:) This .p1(macro) presents the given .b(string) in
bold face type..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2eent(startup,Engine Startup, ).n
Always ensure there is no gas fume build-up in
the bilge. \'2eb(THIS IS VERY IMPORTANT.)\'2en.n
Switch on the ignition and press the start button.\'2en.n
\'2eend.n.n
.]
.b(SEE ALSO:) .j(cmdi,\'2ei) .j(cmdbu,\'2ebu) .j(cmdiu,\'2eiu).n
.end
.com(=================================)
.com( i macro topic )
.com(=================================)
.ent(cmdi,\'2ei Macro,The )
.b(SYNTAX:) \'2ei(string).n
.n
.b(EXPLANATION:) This .p1(macro) presents the given .b(string) in
italic type..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2eent(chars,Characters,Game ).n
Your opponents in the game consist of \'2ei(trolls),
rabid \'2ei(dogs) and defenseless \'2ei(kittens)..n
\'2eend.n.n
.]
.b(SEE ALSO:) .j(cmdb,\'2eb) .j(cmdbu,\'2ebu) .j(cmdiu,\'2eiu).n
.end
.com(=================================)
.com( [ macro topic )
.com(=================================)
.ent(cmdob,\'2e[ Macro,The )
.b(SYNTAX:) \'2e[.n
.n
.b(EXPLANATION:) This .p1(macro) marks the beginning of a region of
text that will appear in a bold, fixed-width font. This is suitable
for showing program examples or tables. NOTE: Since .p1(RTF) files
use the open and close curly braces as part of their syntax, if you
want to display them in your help file, you must 'escape' them by
putting a backslash in front of them. This is shown in the example
below..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2eent(progctl,Control,Program ).n
The program is controlled with a message router:.n
\'2es.n
\'2ein.n
\'2e[.n
switch(wParam)\'2en.n
\\\{\'2en.n
\\tab case ID_OPEN: . . . \'2en.n
\\tab \\tab break;\'2en.n
\\tab case ID_CLOSE: . . . \'2en.n
\\tab \\tab break;\'2en.n
\\\}\'2en.n
\'2e].n
\'2eun.n
\'2eend.n.n
.]
.b(SEE ALSO:) .j(cmdcb,\'2e]).n
.end
.com(=================================)
.com( ] macro topic )
.com(=================================)
.ent(cmdcb,\'2e] Macro,The )
.b(SYNTAX:) \'2e].n
.n
.b(EXPLANATION:) This .p1(macro) marks the end of a region that was
started with \'2e[. There should be a \'2e] for every \'2e[..n
.n
.b(EXAMPLE:) See the example for the \'2e[ command..n
.n
.b(SEE ALSO:) .j(cmdob,\'2e[).n
.end
.com(=================================)
.com( n macro topic )
.com(=================================)
.ent(cmdn,\'2en Macro,The )
.b(SYNTAX:) \'2en.n
.n
.b(EXPLANATION:) This .p1(macro) is used at the end of a line, or on
a line of its own, to indicate the actual end of the line. When
\'2en is not used, separate lines are simply run together and used
to fill whatever WinHelp window width the user has chosen..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2eent(drjnk,Health,To Your ).n
This sentence will adjust itself to the.n
width of the help window, since there is no.n
\\'2en at the end of each line.\'2en\'2en.n.n
This sentence will not adjust itself,\'2en.n
since there is a \\'2en at the end of\'2en.n
each line.\'2en.n
\'2eend.n.n
.]
.b(SEE ALSO:) .j(cmds,\'2es).n
.end
.com(=================================)
.com( s macro topic )
.com(=================================)
.ent(cmds,\'2es Macro,The )
.b(SYNTAX:) \'2es.n
.n
.b(EXPLANATION:) This .p1(macro) is used between lines to skip a
space. If \'2es is used, then don't use \'2en.
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2eent(morjnk,Health,To My ).n
This paragraph will be printed with the appropriate.n
word wrapping and line wrapping. All parts of the.n
paragraph will remain connected..n
\'2es.n
The \'2es above will separate this paragraph from.n
the preceeding paragraph. The separation is slightly.n
more than a single line spacing..n
\'2eend.n.n
.]
.b(SEE ALSO:) .j(cmdn,\'2en).n
.end
.com(=================================)
.com( c macro topic )
.com(=================================)
.ent(cmdc,\'2ec Macro,The )
.b(SYNTAX:) \'2ec(color,string).n
.n
.b(EXPLANATION:) This .p1(macro) is used to change the color of the text
.b(string) to .b(color)..n.n
The colors that this macro supports are.n.n
.in
.[
0 - Default color.n
1 - Blue.n
2 - Green.n
3 - Cyan.n
4 - Red.n
5 - Magenta.n
6 - Brown.n
7 - Dark gray.n
8 - Light gray.n
9 - Light blue.n
10 - Light green.n
11 - Light cyan.n
12 - Light red.n
13 - Light magenta.n
14 - Yellow.n
15 - White.n
16 - Pool table green.n
.]
.un
.box
If you attempt to display a color that is the same as the Help file's
background color, the default color will display instead.
.bend
.n.n
.b(EXAMPLE:).n
.n
.[
\li720
You may use \'2ec(12,color) for emphasis in text.\'2en
.n.n
.]
.b(SEE ALSO:).n
.end
.com(=================================)
.com( Help macro macro topic )
.com(=================================)
.ent(cmdmacro,\'2emacro Macro,The )
.b(SYNTAX:) \'2emacro(help_macro,string).n
.n
.b(EXPLANATION:)
.n
This macro underlines the .b(string) text as if a jump is there, but
executes a Winhelp macro instead of jumping. Any Winhelp macro
with no arguments may be executed. The Winhelp macros include:.n.n
.in
#b(About)Display the Winhelp About box..n
#b(Annotate)Display the Winhelp Annotation dialog box..n
#b(Back)Display the previously viewed topic..n
#b(BookmarkDefine)Display the Bookmark Define dialog box..n
#b(BookmarkMore)Display the Bookmark dialog box..n
#b(BrowseButtons)Display the browse buttons on the Winhelp
button bar..n
#b(Contents)Display the Contents topic in the current help file..n
#b(CopyDialog)Display the Copy dialog box..n
#b(CopyTopic)Copies the currently displayed topic to the Windows
Clipboard..n
#b(Exit)Exit from Winhelp and the current help file..n
#b(FileOpen)Display the File Open dialog box..n
#b(FloatingMenu)Display the floating menu, if it is defined..n
#b(HelpOn)Display the Help On Help file..n
#b(HelpOnTop)Toggle the Winhelp Always On Top menu item..n
#b(History)Display the History Window..n
#b(JumpHelpOn)Displays the Help On Help file..n
#b(Next)Display the next topic in the current browse context..n
#b(Prev)Display the previous topic in the current browse context..n
#b(Print)Print the currently displayed topic on the printer..n
#b(PrinterSetup)Display the Printer Setup dialog box..n
#b(ResetMenu)Reset the Winhelp menu to its default..n
#b(Search)Display the Search dialog box..n
.un
.n
.b(EXAMPLE:).n
.[
\li720
\'2eent(b213,Bearings, Roller).n
The roller bearings are an important part of the.n
system.\'2es.n
\'2emacro(Print,Print) this topic.\'2en.n
\'2eend.n
.]
.b(SEE ALSO:) .j(cmdbmacro,\'2ebmacro).n
.end
.com(=================================)
.com( Help bmacro macro topic )
.com(=================================)
.ent(cmdbmacro,\'2ebmacro Macro,The )
.b(SYNTAX:) \'2ebmacro(help_macro,bitmap_name).n
.n
.b(EXPLANATION:)
.n
This macro creates a graphical jump area using .b(bitmap_name) as the
graphic. When the user clicks on the graphic, the Winhelp macro will
execute, instead of performing a jump. See the \'2emacro command
for a list of executable Winhelp macros..n
.n
.b(EXAMPLE:).n
.[
\li720
\'2eent(rm41,Bearings,More on ).n
This is the More on Bearings topic.\'2es.n
\'2ebmacro(Prev,previous\'2ebmp) Previous subject.\'2en.n
\'2eend.n
.]
.b(SEE ALSO:) .j(cmdmacro,\'2emacro).n
.end
.com(=================================)
.com( begin_file macro topic )
.com(=================================)
.ent(cmdbf,\'2ebegin_file Macro,The )
.b(SYNTAX:) \'2ebegin_file.n
.n
.b(EXPLANATION:) This .p1(macro) marks the start of an additional
macro file for projects that must be divided into multiple files..n
.n
.b(EXAMPLE:).n
.[
\li720
First file:.n.n
\'2estart(...).n
\'2e.n
\'2e.n
\'2e.n
\'2eend_file.n.n
Second file:.n.n
\'2ebegin_file.n
\'2e.n
\'2e.n
\'2e.n
\'2eend_file.n
.]
.n
.b(SEE ALSO:) .j(cmdstr,\'2estart), .j(cmdef,\'2eend_file).n
.end
.com(=================================)
.com( end_file macro topic )
.com(=================================)
.ent(cmdef,\'2eend_file Macro,The )
.b(SYNTAX:) \'2eend_file.n
.n
.b(EXPLANATION:) This .p1(macro) marks the end of the macro file..n
.n
.b(EXAMPLE:) See the example for the \'2estart command..n
.n
.b(SEE ALSO:) .j(cmdstr,\'2estart).n
.end
.com(=================================)
.com( brdrdb command topic )
.com(=================================)
.ent(cmdbrdrdb,\\brdrdb Command,The )
.b(EXPLANATION:) This command changes the border line style to a
double line. It is used as a modifier to the \'2ebox command..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2ebox.n
\\brdrdb.n
This text will be displayed in a box with a double line border..n
\'2ebend.n
.]
.end
.com(=================================)
.com( brdrs command topic )
.com(=================================)
.ent(cmdbrdrs,\\brdrs Command,The )
.b(EXPLANATION:) This command changes the border line style to a
single line (this is the default). It is used as a modifier to the
\'2ebox command..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2ebox.n
\\brdrth.n
This text will be displayed in a box with a thick border..n
\\brdrs.n
And this text will be displayed in a another box with a single
line border..n
\'2ebend.n
.]
.end
.com(=================================)
.com( brdrsh command topic )
.com(=================================)
.ent(cmdbrdrsh,\\brdrsh Command,The )
.b(EXPLANATION:) This command changes the border line style to
shaded style. It is used as a modifier to the \'2ebox command..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\'2ebox.n
\\brdrsh.n
This text will be displayed in a box with a shaded border..n
\'2ebend.n
.]
.end
.com(=================================)
.com( brdrth command topic )
.com(=================================)
.ent(cmdbrdrth,\\brdrth Command,The )
.b(EXPLANATION:) This command changes the border line style to a
thick line. It is used as a modifier to the \'2ebox command..n
.n
.b(EXAMPLE:) See the example for the \\brdrs command..n
.n
.end
.com(=================================)
.com( li command topic )
.com(=================================)
.ent(cmdli,\\li Command,The )
.b(EXPLANATION:) This command changes the left margin indentation to
the value that immediately follows the command. The value is
expressed in .p1(twips). To reset the margin to its default, use
\\li180..n
.n
.b(EXAMPLE:).n
.n
\'2e[.n
\\li720.n
\\ri720.n
This sentence will be indented on the left and right margins by
720/1440 = 1/2"..n
\'2e].n
\\li180.n
\\ri180.n
.end
.com(=================================)
.com( ri command topic )
.com(=================================)
.ent(cmdri,\\ri Command,The )
.b(EXPLANATION:) This command changes the right margin indentation to
the value that immediately follows the command. The value is
expressed in .p1(twips). To reset the margin to its default, use
\\ri180..n
.n
.b(EXAMPLE:) See the example for the \\li command..n
.end
.com(=================================)
.com( ql command topic )
.com(=================================)
.ent(cmdql,\\ql Command,The )
.b(EXPLANATION:) This command changes the paragraph style to left
justified. This is the default paragraph style..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\\qc.n
This paragraph will have every line centered in the
help window..n
\'2es.n
\\ql.n
Now we are back to the default left justified paragraph..n
.]
.end
.com(=================================)
.com( qr command topic )
.com(=================================)
.ent(cmdqr,\\qr Command,The )
.b(EXPLANATION:) This command changes the paragraph style to right
justified..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
This paragraph is normally left justified..n
\'2es.n
\\qr.n
And this paragraph is right justified..n
\'2es.n
.]
.end
.com(=================================)
.com( qj command topic )
.com(=================================)
.ent(cmdqj,\\qj Command,The )
.b(EXPLANATION:) This command changes the paragraph style to fully
justified..n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\\qj.n
The quick brown fox normally jumps over the lazy dog's
back in a fully justified fashion..n
\'2es.n
.]
.end
.com(=================================)
.com( qc command topic )
.com(=================================)
.ent(cmdqc,\\qc Command,The )
.b(EXPLANATION:) This command changes the paragraph style to
centered lines..n
.n
.b(EXAMPLE:) See the example for the \\ql command..n
.n
.end
.com(=================================)
.com( tab command topic )
.com(=================================)
.ent(cmdtab,\\tab Command,The )
.b(EXPLANATION:) This command places a tab character in the macro
and in the generated RTF file..n
.n
.b(EXAMPLE:) See the example for the \'2e[ macro language command..n
.n
.end
.com(=================================)
.com( 'hh command topic )
.com(=================================)
.ent(cmdhh,\\'hh Command,The )
.b(EXPLANATION:) This command allows you to put extended characters
into a help file. Some commonly used extended characters are.n
.n
\tab\\'a9 => \'a9.n
\tab\\'ae => \'ae.n
\tab\\'bc => \'bc.n
\tab\\'bd => \'bd.n
\tab\\'be => \'be.n
\tab\\'99 => \'99 (trademark symbol. This one may not work
correctly, depending on the help compiler).n
.n
.b(EXAMPLE:).n
.n
.[
\li720
\\'a9 1994 Rimrock Software. All rights reserved.\'2en.n
Distributed on 3\\'bd double density floppy disk..n
.]
.end
.com(=================================)
.com( glossary topic )
.com(=================================)
.ent(glossary,Glossary, )
.in
##.p(hlpcmplr,help compiler)
##.p1(HTML)
##.p1(macro)
##.p1(popup)
##.p1(project)
##.p1(RTF)
##.p(rtfcmds,RTF commands)
##.p1(shareware)
##.p1(template)
##.p(titlebar,title bar)
##.p1(toolbar)
##.p1(topic)
##.p1(twips)
.un
.end
.com(=================================)
.com( macro popup )
.com(=================================)
.pent(macro,macro, )
The replacement of a long series of .p1(RTF) commands with a single
command word and (optional) series of arguments.
.end
.com(=================================)
.com( shareware popup )
.com(=================================)
.pent(shareware,shareware, )
A software distribution method. Software is distributed for trial
use, and if users find it useful, they are expected to pay a
registration fee ('try before you buy').
.end
.com(=================================)
.com( template popup )
.com(=================================)
.pent(template,template, )
A series of text lines that constitute the minimal macro
file that will convert to an RTF file and compile to a
help file.
.end
.com(=================================)
.com( project popup )
.com(=================================)
.pent(project,project, )
A file with the extension .HPJ, that contains options that
specifies how a help file is to be built. Required by the
help compiler.
.end
.com(=================================)
.com( RTF popup )
.com(=================================)
.pent(RTF,RTF, )
Rich Text Format, a standard text file formatting standard. An
RTF file consists of .p(rtfcmds,RTF commands) and normal text.
.end
.com(=================================)
.com( RTF commands popup )
.com(=================================)
.pent(rtfcmds,RTF commands, )
Special commands in an .p1(RTF) file that describe how text is to be
displayed. These commands start with a backslash (\\) character.
.end
.com(=================================)
.com( help compiler popup )
.com(=================================)
.pent(hlpcmplr,help compiler, )
The program that creates a help (.HLP) file from the .RTF file,
using the rules detailed in the .HPJ file.
.end
.com(=================================)
.com( toolbar popup )
.com(=================================)
.pent(toolbar,toolbar, )
The line of graphical push buttons that are located directly
below HelpGen's menu bar.
.end
.com(=================================)
.com( title bar popup )
.com(=================================)
.pent(titlebar,title bar, )
The area at the top of the HelpGen program window that contains
the program name, file name, system menu button and window size
controls.
.end
.com(=================================)
.com( topic popup )
.com(=================================)
.pent(topic,topic, )
A block of text in a help file that will be displayed as a single
display page.
.end
.com(=================================)
.com( popup popup )
.com(=================================)
.pent(popup,popup, )
A small window that appears when you select a topic with a dotted
underline. The window will remain until you click the left mouse
button again.
.end
.com(=================================)
.com( twips popup )
.com(=================================)
.pent(twips,twips, )
A 20th of a point. There are 72 points in an inch, so there
are 1440 twips in an inch.
.end
.com(=================================)
.com( html popup )
.com(=================================)
.pent(HTML,HTML, )
HyperText Markup Language. The language used by the World
Wide Web on the Internet.
.end
.com(=================================)
.com( End of HelpGen macro file )
.com(=================================)
.end_file